Paysafe
Paysafe is a third party supplier which is integrated with ebs to process online payments. You must contact Paysafe to agree a contract.
When you have negotiated a contract and been through the testing process with Paysafe you are ready to start the configuration with ebs. At this point you should have received a URL from Paysafe that is specific to your organisation.
Note: Refer to the Paysafe website for further information about error codes.
The institution settings for Paysafe are configured on the following screens (accessed from the Product Modules pane):
ePayments (Self-Service)
The institution settings on the ePayments (Self-Service) screen for Paysafe are shown below.
The fields on the ePayments (Self-Service) screen that are relevant to Paysafe are described in the following table. It is recommended that unused fields are left blank.
| This field | Holds this information... |
|---|---|
| ePayment version | The electronic payment provider being used for ebs: ontrack Learner Hub. Select Paysafe from the drop-down list. |
| ePayment URL |
The URL provided by Paysafe. This should be in one of the following formats:
Note: This field must include the URL of your payment provider. |
| Payment Account ID | The Paysafe account ID. |
| Payment Account Key | The single-use token-generating API key (used in the client-side JavaScript code). |
| Payment Security Key | The server-to-server API key. |
| Only use default account code for payments | It is recommended this field is set to N for Paysafe. |
| Payment Merchant Reference | The payment merchant reference for Paysafe. |
| Default Payment Email Address | The email address to which transaction emails are sent (that is: your ebs: ontrack Learner Hub URL). |
| Payment Host IP Address | The payment host IP address for Paysafe. |
| Payment Process Allowed IP Addresses - (Empty=Allow All) | The payment process allowed IP address for Paysafe or leave blank to allow all. |
| Default VAT code | The default VAT code to use for Paysafe. |
| ePayment failure message (Prospect) | The message displayed to learners in ebs: ontrack Learner Hub when payment fails in the institution's payment provider. |
ePayments (ebs: Staff)
The institution settings on the ePayments (Staff) screen for Paysafe are shown below.
The fields on the ePayments (Staff) screen that are relevant to Paysafe are described in the following table. It is recommended that unused fields are left blank.
| This field | Holds this information... |
|---|---|
| ePayment version | The electronic payment provider being used for ebs: central. Select Paysafe from the drop-down list. |
| ePayment URL |
The URL provided by Paysafe. This should be in one of the following formats:
Note: This field must include the URL of your payment provider. |
| Payment Account ID | The Paysafe account ID. |
| Payment Account Key | The single-use token-generating API key (used in the client-side JavaScript code). |
| Payment Security Key | The server-to-server API key. |
| Only use default account code for payments | It is recommended this field is set to N for Paysafe. |
| Default Payment Email Address | The email address to which transaction emails are sent. |
| Payment Host IP Address | The payment host IP address for Paysafe. |
| Payment Process Allowed IP Addresses - (Empty=Allow All) | The payment process allowed IP address for Paysafe or leave blank to allow all. |
| Only use default VAT code for payments | It is recommended this field is set to N for Paysafe. |
| Default VAT code | The default VAT code to use for Paysafe. |
| The Method of Transfer That ebs: central Uses For ePayments |
The method of transfer that ebs uses for ePayments. Select Open in default browser for Paysafe. Note: You must select Open in default browser for Paysafe. |
The following configuration information for Paysafe is also applicable:
Payment Account Key
Use the Single-Use Token section of the API Keys screen to create a Payment Account Key.
A username and password is provided when you generate a Single-Use Token.
You can generate a new Base64 format encoded key with a converter, using the format 'username:password', where:
- username - the Single-Use Token username
- : - a colon, without any spaces, separates the username and password values
- password - the Single-Use Token password
For example: tribal:group
Note: You can use a converter (for example: base64encode) to encode the username and password (for example: the username tribal and password group is converted to tribal:group, which is encoded to dHJpYmFsOmdyb3Vw).
Payment Security Key
The data sent to Paysafe when making a payment is described in the following table.
| Value | Source | Notes |
|---|---|---|
| PublicToken | Payment Account Key | Sent in the JS in PaySafe.aspx when setting up the payment iframe |
| amount | The total amount being paid | - |
| holderName | The Full Name of the person making the payment | - |
| currency | 'GBP', 'AUD' or 'NZD' | Dependent on institution type |
| environment | 'TEST' or 'LIVE' | 'TEST' if PaymentProviderTestMode = True |
| companyName | Organisation Name institution setting | - |
| account.CC | Payment Account ID | - |
| threeDS.useThreeDSecureVersion2 | True or false | Used to enable 3DS2 security. If payment mode is staff then false, otherwise true |
| billingAddress.country | ISO2 country code populated from a drop-down | Drop-down values built from verifiers in ISO_ALPHA_2_COUNTRY_CODE domain |
| billingAddress.zip | Postcode from payment person details | Mandatory for 3DS2 verification |
| billingAddress.street | AddressLine1 from payment person details | Mandatory for 3DS2 verification |
The data sent to Paysafe when a payment is verified is described in the following table.
| Value | Source | Notes |
|---|---|---|
| amount | The total amount being paid | - |
| firstName | The forename from the payment details | - |
| lastName | The surname from the payment details | - |
| The email address from the payment details | - |
Note: Refer to PCI Compliance for further information about how ebs interacts with Paysafe.